IRIX Base Documentation 2002 November

home *** CD-ROM | disk | FTP | other *** search

/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cato / Xm / MrmOpenHierarchy.z / MrmOpenHierarchy

Wrap

Text File | 2002-10-03 | 16.7 KB | 265 lines

MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX)))) NNNNAAAAMMMMEEEE MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy - Allocates a hierarchy ID and opens all the UID files in the hierarchy SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS ####iiiinnnncccclllluuuuddddeeee <<<<MMMMrrrrmmmm////MMMMrrrrmmmmPPPPuuuubbbblllliiiicccc....hhhh>>>> CCCCaaaarrrrddddiiiinnnnaaaallll MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((_n_u_m__f_i_l_e_s, _f_i_l_e__n_a_m_e_s__l_i_s_t, _a_n_c_i_l_l_a_r_y__s_t_r_u_c_t_u_r_e_s__l_i_s_t, _h_i_e_r_a_r_c_h_y__i_d)))) MMMMrrrrmmmmCCCCoooouuuunnnntttt _n_u_m__f_i_l_e_s;;;; SSSSttttrrrriiiinnnngggg _f_i_l_e__n_a_m_e_s__l_i_s_t[[[[]]]];;;; MMMMrrrrmmmmOOOOssssOOOOppppeeeennnnPPPPaaaarrrraaaammmmPPPPttttrrrr ****_a_n_c_i_l_l_a_r_y__s_t_r_u_c_t_u_r_e_s__l_i_s_t;;;; MMMMrrrrmmmmHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy ****_h_i_e_r_a_r_c_h_y__i_d;;;; VVVVEEEERRRRSSSSIIIIOOOONNNN This page documents version 1.2 of the Motif library. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN This routine is obsolete and exists for compatibility with previous releases. It is replaced by MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy. MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy is identical to MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy except that MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy does not take a _d_i_s_p_l_a_y argument. _n_u_m__f_i_l_e_s Specifies the number of files in the name list. _f_i_l_e__n_a_m_e_s__l_i_s_t Specifies an array of character strings that identify the UID files. _a_n_c_i_l_l_a_r_y__s_t_r_u_c_t_u_r_e_s__l_i_s_t A list of operating-system-dependent ancillary structures corresponding to such things as filenames, clobber flag, and so forth. This argument should be NULL for most operations. If you need to reference this structure, see the definition of MMMMrrrrmmmmOOOOssssOOOOppppeeeennnnPPPPaaaarrrraaaammmmPPPPttttrrrr in MMMMrrrrmmmmPPPPuuuubbbblllliiiicccc....hhhh for more information. _h_i_e_r_a_r_c_h_y__i_d Returns the search hierarchy ID. The search hierarchy ID identifies the list of UID files that MRM searches (in order) when performing subsequent fetch calls. Each UID file string in _f_i_l_e__n_a_m_e_s__l_i_s_t can specify either a full pathname or a filename. If a UID file string has a leading slash (/), it specifies a full pathname, and MRM opens the file as specified. Otherwise, the UID file string specifies a filename. In this case MRM looks for the file Page 1 (printed 10/3/02) MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX)))) along a search path specified by the UUUUIIIIDDDDPPPPAAAATTTTHHHH environment variable or by a default search path, which varies depending on whether or not the XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR environment variable is set. The UUUUIIIIDDDDPPPPAAAATTTTHHHH environment variable specifies a search path and naming conventions associated with UID files. It can contain the substitution field %U, where the UID file string from the _f_i_l_e__n_a_m_e_s__l_i_s_t argument to MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy is substituted for %U. It can also contain the substitution fields accepted by XXXXttttRRRReeeessssoooollllvvvveeeePPPPaaaatttthhhhnnnnaaaammmmeeee. The substitution field %T is always mapped to uuuuiiiidddd. The entire path is first searched with %S mapped to ....uuuuiiiidddd and then, if no file is found, is searched again with %S mapped to NULL. If no display is set prior to calling this function, the result of this function's call to XXXXttttRRRReeeessssoooollllvvvveeeePPPPaaaatttthhhhnnnnaaaammmmeeee is undefined. For example, the following UUUUIIIIDDDDPPPPAAAATTTTHHHH value and MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy call cause MRM to open two separate UID files: UIDPATH=/uidlib/%L/%U.uid:/uidlib/%U/%L static char *uid_files[] = {"/usr/users/me/test.uid", "test2"}; MrmHierarchy *Hierarchy_id; MrmOpenHierarchy((MrmCount)2,uid_files, NULL, Hierarchy_id) MRM opens the first file, ////uuuussssrrrr////uuuusssseeeerrrrssss////mmmmeeee////tttteeeesssstttt....uuuuiiiidddd, as specified in the _f_i_l_e__n_a_m_e_s__l_i_s_t argument to MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy, because the UID file string in the _f_i_l_e__n_a_m_e_s__l_i_s_t argument specifies a full pathname. MRM looks for the second file, tttteeeesssstttt2222, first as ////uuuuiiiiddddlllliiiibbbb////%%%%LLLL////tttteeeesssstttt2222....uuuuiiiidddd and second as ////uuuuiiiiddddlllliiiibbbb////tttteeeesssstttt2222////%%%%LLLL, where the display's language string is substituted for %L. After MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy opens the UID hierarchy, you should not delete or modify the UID files until you close the UID hierarchy by calling MMMMrrrrmmmmCCCClllloooosssseeeeHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy. If UUUUIIIIDDDDPPPPAAAATTTTHHHH is not set but the environment variable XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR is set, MRM searches the following pathnames: %%%%PPPP $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%LLLL////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%llll////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%LLLL////uuuuiiiidddd////%%%%UUUU%%%%SSSS $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////%%%%llll////uuuuiiiidddd////%%%%UUUU%%%%SSSS $$$$XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR////uuuuiiiidddd////%%%%UUUU%%%%SSSS Page 2 (printed 10/3/02) MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX)))) $$$$HHHHOOOOMMMMEEEE////uuuuiiiidddd////%%%%UUUU%%%%SSSS $$$$HHHHOOOOMMMMEEEE////%%%%UUUU%%%%SSSS ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////uuuuiiiidddd////%%%%UUUU%%%%SSSS ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////uuuuiiiidddd////%%%%UUUU%%%%SSSS ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////uuuuiiiidddd////%%%%UUUU%%%%SSSS ////uuuussssrrrr////iiiinnnncccclllluuuuddddeeee////XXXX11111111////uuuuiiiidddd////%%%%UUUU%%%%SSSS If neither UUUUIIIIDDDDPPPPAAAATTTTHHHH nor XXXXAAAAPPPPPPPPLLLLRRRREEEESSSSDDDDIIIIRRRR is set, MRM searches the following pathnames: %%%%UUUU%%%%SSSS $$$$HHHHOOOOMMMMEEEE////%%%%LLLL////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS $$$$HHHHOOOOMMMMEEEE////%%%%llll////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS $$$$HHHHOOOOMMMMEEEE////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS $$$$HHHHOOOOMMMMEEEE////%%%%LLLL////uuuuiiiidddd////%%%%UUUU%%%%SSSS $$$$HHHHOOOOMMMMEEEE////%%%%llll////uuuuiiiidddd////%%%%UUUU%%%%SSSS $$$$HHHHOOOOMMMMEEEE////uuuuiiiidddd////%%%%UUUU%%%%SSSS $$$$HHHHOOOOMMMMEEEE////%%%%UUUU%%%%SSSS ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////uuuuiiiidddd////%%%%NNNN////%%%%UUUU%%%%SSSS ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%LLLL////uuuuiiiidddd////%%%%UUUU%%%%SSSS ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////%%%%llll////uuuuiiiidddd////%%%%UUUU%%%%SSSS ////uuuussssrrrr////lllliiiibbbb////XXXX11111111////uuuuiiiidddd////%%%%UUUU%%%%SSSS ////uuuussssrrrr////iiiinnnncccclllluuuuddddeeee////XXXX11111111////uuuuiiiidddd////%%%%UUUU%%%%SSSS These paths are defaults that vendors may change. For example, a vendor may use different directories for ////uuuussssrrrr////lllliiiibbbb////XXXX11111111 and ////uuuussssrrrr////iiiinnnncccclllluuuuddddeeee////XXXX11111111. The following substitutions are used in these paths: %%%%UUUU The UID file string, from the _f_i_l_e__n_a_m_e_s__l_i_s_t argument. %%%%NNNN The class name of the application. %%%%LLLL The display's language string. %%%%llll The language component of the display's language string. %%%%SSSS The suffix to the file name. The entire path is searched first with a suffix of ....uuuuiiiillll, and if no file is found, it is searched again with a NULL suffix. Page 3 (printed 10/3/02) MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX)))) RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE This function returns one of these status return constants: MMMMrrrrmmmmSSSSUUUUCCCCCCCCEEEESSSSSSSS The function executed successfully. MMMMrrrrmmmmNNNNOOOOTTTT____FFFFOOOOUUUUNNNNDDDD File not found. MMMMrrrrmmmmFFFFAAAAIIIILLLLUUUURRRREEEE The function failed. RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy((((3333XXXX)))) and MMMMrrrrmmmmCCCClllloooosssseeeeHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy((((3333XXXX)))). Page 4 (printed 10/3/02)